// Copyright 2020 The XLS Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef XLS_SCHEDULING_PIPELINE_SCHEDULING_PASS_H_
#define XLS_SCHEDULING_PIPELINE_SCHEDULING_PASS_H_

#include "absl/status/statusor.h"
#include "xls/ir/package.h"
#include "xls/passes/pass_base.h"
#include "xls/scheduling/scheduling_pass.h"

namespace xls {

// Pass which creates a feedforward pipeline schedule for the entry function in
// the package. The IR is not mutated by this pass, only the schedule. If the
// SchedulingUnit already contains a schedule, it will be used to constrain the
// scheduler.
class PipelineSchedulingPass : public SchedulingPass {
 public:
  PipelineSchedulingPass()
      : SchedulingPass("pipesched", "Pipeline Scheduling") {}
  ~PipelineSchedulingPass() override = default;

 protected:
  absl::StatusOr<bool> RunInternal(Package* package,
                                   const SchedulingPassOptions& options,
                                   PassResults* results,
                                   SchedulingContext& context) const override;
};

}  // namespace xls

#endif  // XLS_SCHEDULING_PIPELINE_SCHEDULING_PASS_H_
